home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / comm / qwkp9605.zip / QWK.TXT < prev    next >
Text File  |  1996-05-04  |  53KB  |  1,179 lines
  1.                      QWK Mail Packet File Layout
  2.                           by Patrick Y. Lee
  3.  
  4. Version 1.6 - December 19, 1992
  5.      Added off-line commands for QSO (door for TBBS), thanks to
  6.      message from Bob Hartman in the FidoNet Off-line echo.  All
  7.      8-bit characters have been replaced with either blanks or
  8.      equivalent 7-bit characters so I can send this file easily via
  9.      Internet email.  Line 9 of the CONTROL.DAT file seems to be
  10.      used by a few doors to indicate the NetMail conference.
  11. Version 1.5 - July 30, 1992
  12.      Added off-line commands for Cam-Mail door.  Fixed error in the
  13.      status flag section.  The descriptions for `*' and `+' are
  14.      incorrect.  Thanks to Bob Blaylock for bringing this up.
  15. Version 1.4 - July 18, 1992
  16.      Fixed a few minor mistakes in the documentation (thanks to
  17.      Cody Gibson).  Nothing really major.  Also completed the
  18.      Netmail section of the documentation.
  19. Version 1.3 - July 6, 1992
  20.      Added changes to the QWK format adopted by Qmail door.  Spe-
  21.      cifically line 10 of CONTROL.DAT file and bytes 126-127 of
  22.      MESSAGES.DAT file.  Please refer to the appropriate section
  23.      for the changes.
  24. Version 1.2 - May 31, 1992
  25.      Added a few items to the DOOR.ID file that is being supported
  26.      by Qmail DeLuxe2 version 1.25.
  27. Version 1.1 - March 15, 1992
  28.      Minor fixes here and there to make everything just right.
  29. Version 1.0 - February 23, 1992
  30.      First release.
  31.  
  32. This document is Copyright 1992 by Patrick Y. Lee.
  33.  
  34. The QWK-format is Copyright 1987 by Sparkware.
  35.  
  36. All program names mentioned in this document are either Copyright
  37. or Trademark of respective owners.
  38.  
  39. The author provides this file as-is without warranty of any kind,
  40. either expressed or implied.  You are using the information in this
  41. file at your own discretion.  The author assumes no responsibili-
  42. ties for damages, either physically or financially, from the use of
  43. this information.
  44.  
  45. This document may be freely distributed by any means (electronical-
  46. ly, paper, etc.), provided that it is distributed in its entirety. 
  47. Portions of this document may be reproduced without credit.
  48.  
  49.                     -=-=-=-=-=-=-<>-=-=-=-=-=-=-
  50.  
  51.                           Table of Contents
  52.  
  53. 1.  Introduction
  54.     1.1.  Intent
  55.     1.2.  History
  56.     1.3.  Questions, corrections, etc.
  57. 2.  Conventions & overview
  58.     2.1.  The BBS ID
  59.     2.2.  Packet compression
  60.     2.3.  Packet transfer & protocols
  61.     2.4.  Limitations
  62. 3.  QWK files
  63.     3.1.  Naming convention
  64.     3.2.  Control file (CONTROL.DAT)
  65.     3.3.  Welcome file
  66.     3.4.  Goodbye file
  67.     3.5.  News file
  68.     3.6.  Qmail DeLuxe2 menu file
  69.     3.7.  New uploads listing (NEWFILES.DAT)
  70.     3.8.  Bulletin file(s) (BLT-x.y)
  71.     3.9.  Message file (MESSAGES.DAT)
  72.     3.10.  Index files (*.NDX)
  73.         3.10.1.  Conference indices
  74.         3.10.2.  Personal index (PERSONAL.NDX)
  75.     3.11.  Pointer file
  76.     3.12.  SESSION.TXT
  77. 4.  REP files
  78.     4.1.  Naming convention
  79.     4.2.  Message file (BBSID.MSG)
  80.     4.3.  Door control messages
  81.     4.3.1.  DOOR.ID file
  82.     4.3.2.  Qmail
  83.     4.3.3.  MarkMail
  84.     4.3.4.  KMail
  85.     4.3.5.  RoseMail
  86.     4.3.6.  Complete Mail Door
  87.     4.3.7.  The MainMail System
  88.     4.3.8.  BGQWK
  89.     4.3.9.  UltraBBS
  90.     4.3.10.  TriMail
  91.     4.3.11.  Cam-Mail
  92.     4.3.12.  QSO
  93.     4.3.13.  TGWave
  94.     4.4.  Turning off the echo flag
  95.     4.5.  Tag-lines
  96. 5.  Net mail
  97. A.  Credits & contributions
  98. B.  Sample Turbo Pascal and C code
  99. C.  Sample message
  100. D.  Sample index file
  101.  
  102.                     -=-=-=-=-=-=-<>-=-=-=-=-=-=-
  103.  
  104. To search for a specific section, look for "[x.x]" using your edi-
  105. tor or viewer.  For example, to jump to the tag-lines portion of
  106. this file, search for "[4.5]" with your editor or text viewer.
  107.  
  108.                     -=-=-=-=-=-=-<>-=-=-=-=-=-=-
  109.  
  110. [1]  Introduction
  111.  
  112. [1.1]  Intent
  113.  
  114. This document is written to facilitate programmers who want to write
  115. QWK-format mail doors or readers.  It is intended to be a comprehen-
  116. sive reference covering all areas of QWK-format mail processing. 
  117. Detailed break down of each file is included, as are implementation
  118. information.  In addition, door and reader specific information may be
  119. included, when such information are available to me.
  120.  
  121. [1.2]  History
  122.  
  123. The QWK-format was invented by Mark "Sparky" Herring in 1987.  It was
  124. based on Clark Development Corporation's PCBoard version 12.0 message
  125. base format.  Off-line mail reading has become popular only in recent
  126. years.  Prior to summer of 1990, there were only two QWK-format off-
  127. line mail reader programs.  They were Qmail DeLuxe by Mark Herring and
  128. EZ-Reader by Eric Cockrell.  Similarly for the doors, there were only
  129. two -- Qmail by Mark Herring and MarkMail by Mark Turner.  They were
  130. both for PCBoard systems.
  131.  
  132. A lot has changed in both off-line reader and mail door markets since
  133. summer 1990.  Now, there are more than a dozen off-line mail readers
  134. for the PC.  Readers for the Macintosh, Amiga, and Atari exist as
  135. well.  There are over a half dozen doors for PCBoard, and QWK-format
  136. doors exist for virtually all of the popular BBS softwares.  All of
  137. these happened in less than two years!  More readers and doors are in
  138. development as I write this, keep up the excellent work.  In addition
  139. to doors, some BBS softwares has QWK-format mail facility built in.
  140.  
  141. Off-line mail reading is an integral part of BBS calling.  Conference
  142. traffic and selection on all networks have grown dramatically in re-
  143. cent years that on-line reading is a thing of the past.  Off-line mail
  144. reading offers an alternative to reading mail on-line -- It offers
  145. speed that cannot be achieved with on-line mail reading.
  146.  
  147. The reason why QWK-format readers and doors seem to have gained popu-
  148. larity is probably dued to its openness.  The format is readily avail-
  149. able to any programmer who wishes to write a program that utilize it. 
  150. Proprietary is a thing of the past, it does not work!  Openness is
  151. here to stay and QWK-format is a part of it.
  152.  
  153. [1.3]  Questions, corrections, etc.
  154.  
  155. Most of the message networks today have a conference/echo devoted to
  156. discussion of off-line readers and mail doors.  The ones I know are on
  157. FidoNet, ILink, Intelec, and RIME.  If you have questions after read-
  158. ing anything in here, feel free to drop by any of the above conference
  159. /echo and I am sure other QWK authors will try to help.
  160.  
  161. I can be reached at:
  162.  
  163. CompuServe: >INTERNET:patlee@panix.com
  164. FidoNet: Off-line echo
  165. ILink: Off-line conference
  166. Intelec: Off-line conference
  167. Internet: patlee@panix.com
  168. PlanoNet: Reviews conference
  169. RIME: ->RUNNINGB, Off-line, Common, Net Admin., Shareware, New Users,
  170. and Session Manager conferences
  171.  
  172. Any corrections, extensions, comments, and criticisms are welcomed. 
  173. Messages from Internet and RIME will probably be answered first.  But
  174. I do check mail on all other places at least once a week.
  175.  
  176. [2]  Conventions & overview
  177.  
  178. All offsets referenced in this document will be relative to 1.  I am
  179. not a computer, I start counting at one, not zero!
  180.  
  181. Words which are enclosed in quotes should be entered as-is.  The quo-
  182. tations are not part of the string unless noted.
  183.  
  184. You may have noticed I use the phrase "mail program" or "mail facili-
  185. ty" instead of mail doors.  This is because some BBS softwares offer
  186. the option of creating QWK-format mail packets right from the BBS. 
  187. With those, there is no need for an external mail door.
  188.  
  189. [2.1]  The BBS ID
  190.  
  191. The BBS ID (denoted as BBSID) is a 1-8 characters word that identifies
  192. a particular BBS.  This identifier should be obtained from line 5 of
  193. the CONTROL.DAT file (see section 3.2.1).
  194.  
  195. [2.2]  Packet compression
  196.  
  197. Most mail packets are compressed when created by the mail door in
  198. order to save download time and disk space.  However, many off-line
  199. reader programs allow the user to unarchive a mail packet outside of
  200. the reader program, so the reader will not have to unarchive it.  Upon
  201. exit, the reader will not call the archiver to save it.  It is up to
  202. the user to archive the replies.  This is useful if the